CallChoreography.java

/*******************************************************************************
 * Signavio Core Components
 * Copyright (C) 2012  Signavio GmbH
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/
package de.hpi.bpmn2_0.model.choreography;

import java.util.ArrayList;
import java.util.List;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlIDREF;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlTransient;
import javax.xml.bind.annotation.XmlType;

import de.hpi.bpmn2_0.annotations.CallingElement;
import de.hpi.bpmn2_0.annotations.ContainerElement;
import de.hpi.bpmn2_0.model.BaseElement;
import de.hpi.bpmn2_0.model.FlowElement;
import de.hpi.bpmn2_0.model.bpmndi.di.DiagramElement;
import de.hpi.bpmn2_0.model.callable.GlobalChoreographyTask;
import de.hpi.bpmn2_0.model.connector.Edge;
import de.hpi.bpmn2_0.transformation.Visitor;


/**
 * <p>Java class for tCallChoreography complex type.
 * 
 * <p>The following schema fragment specifies the expected content contained within this class.
 * 
 * <pre>
 * <complexType name="tCallChoreography">
 *   <complexContent>
 *     <extension base="{http://www.omg.org/spec/BPMN/20100524/MODEL}tChoreographyActivity">
 *       <sequence>
 *         <element ref="{http://www.omg.org/spec/BPMN/20100524/MODEL}participantAssociation" maxOccurs="unbounded" minOccurs="0"/>
 *       </sequence>
 *       <attribute name="calledChoreographyRef" type="{http://www.w3.org/2001/XMLSchema}QName" />
 *       <anyAttribute processContents='lax' namespace='##other'/>
 *     </extension>
 *   </complexContent>
 * </complexType>
 * </pre>
 * 
 * 
 */
@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "tCallChoreography", propOrder = {
    "participantAssociation"
})
public class CallChoreography
    extends ChoreographyActivity implements ContainerElement, CallingElement
{

    protected List<ParticipantAssociation> participantAssociation;
    @XmlAttribute(name = "calledChoreographyRef")
    @XmlIDREF
    protected Choreography calledChoreographyRef;
    
    @XmlTransient
    public List<DiagramElement> _diagramElements = new ArrayList<DiagramElement>();
    
    /*
     * Constructors
     */
    
    public CallChoreography() {
    	super();
    }
    
    public CallChoreography(ChoreographyActivity choreoAct) {
    	super(choreoAct);
    	
    	this.setStartQuantity(null);
    	this.setCompletionQuantity(null);
    	
    	if(choreoAct instanceof ChoreographyTask) {
    		this.setCalledChoreographyRef(new GlobalChoreographyTask());
    	}
    }

    public List<BaseElement> getCalledElements() {
    	List<BaseElement> calledElements = new ArrayList<BaseElement>();
    	
    	/* Global Task */
    	if(calledChoreographyRef instanceof GlobalChoreographyTask) {
    		calledElements.add(calledChoreographyRef);
    	} 
    	
    	/* Calling a sub choreography */
    	else if(calledChoreographyRef instanceof Choreography) {
    		for(FlowElement flowEl : calledChoreographyRef.getFlowElement()) {
    			if(flowEl instanceof CallingElement) {
    				calledElements.addAll(((CallingElement) flowEl).getCalledElements());
    			}
    		}
    	}
    	
    	return calledElements;
    }
    
    public List<Edge> getChildEdges() {
		List<Edge> edgeList = new ArrayList<Edge>();
		
		for(FlowElement fe : this.getFlowElement()) {
			if(fe instanceof Edge) {
				edgeList.add((Edge) fe);
			} else if(fe instanceof ContainerElement) {
				edgeList.addAll(((ContainerElement) fe).getChildEdges());
			}
		}
		
		return edgeList;
	}
    
    /* Getter & Setter */
    
    /**
     * Gets the value of the participantAssociation property.
     * 
     * <p>
     * This accessor method returns a reference to the live list,
     * not a snapshot. Therefore any modification you make to the
     * returned list will be present inside the JAXB object.
     * This is why there is not a <CODE>set</CODE> method for the participantAssociation property.
     * 
     * <p>
     * For example, to add a new item, do as follows:
     * <pre>
     *    getParticipantAssociation().add(newItem);
     * </pre>
     * 
     * 
     * <p>
     * Objects of the following type(s) are allowed in the list
     * {@link ParticipantAssociation }
     * 
     * 
     */
    public List<ParticipantAssociation> getParticipantAssociation() {
        if (participantAssociation == null) {
            participantAssociation = new ArrayList<ParticipantAssociation>();
        }
        return this.participantAssociation;
    }

    /**
     * Gets the value of the calledChoreographyRef property.
     * 
     * @return
     *     possible object is
     *     {@link Choreography }
     *     
     */
    public Choreography getCalledChoreographyRef() {
        return calledChoreographyRef;
    }

    /**
     * Sets the value of the calledChoreographyRef property.
     * 
     * @param value
     *     allowed object is
     *     {@link Choreography }
     *     
     */
    public void setCalledChoreographyRef(Choreography value) {
        this.calledChoreographyRef = value;
    }
    
    public void acceptVisitor(Visitor v){
		v.visitCallChoreography(this);
	}

	public List<DiagramElement> _getDiagramElements() {
		return _diagramElements;
	}

	public List<FlowElement> getFlowElement() {
		if(this.getCalledChoreographyRef() != null) {
			return this.getCalledChoreographyRef().getFlowElement();
		}
		
		return new ArrayList<FlowElement>();
	}


}